12.2 修改终端信息

请求参数

Path: /api/v1/device/update

Method: POST

接口描述:

  1. 修改终端信息。
  2. 对于更新接口中的非必须参数,如果不传,不会对该条数据相对应参数进行修改。
  3. 如果修改后的终端信息与已存在的终端冲突,则更新失败。
  4. 判断和已存在终端冲突的规则:
    • 请求参数中含有 newExternalId 在设备上已存在终端中,匹配到了相同 externalId 的终端。
    • 根据控制台设置的【终端匹配规则】,mac、计算机名称 与设备上已存在的终端一致。
  5. 接口适用于 v2.2.9 及以上版本。

请求参数

Headers

参数名称 参数值 是否必须 示例 备注
Content-Type application/json 必须  

Body

名称 类型 是否必须 默认值 备注 其他信息
externalId string 必须 外部ID 基于 externalId 匹配待修改终端
newExternalId string 非必须 新外部ID,以该值更新外部ID 传入此参数则更新外部ID,不传则不更新
mac string[] 非必须 MAC地址 支持传入多个MAC地址,不允许传入空数组
deviceType string 非必须 设备类型:'PC' PC端,'Mobile' 移动端
name string 非必须 计算机名称 可通过 hostname 指令获取
assetType string 非必须 资产类型:'CYOD' 企业终端,'BYOD' 个人终端,'COPE' 企业纳管个人终端,'NONE' 未定义  

请求示例

{
    "externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb7",
    "newExternalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb8",
    "name": "DESKTOP-I3ABQBS",
    "mac": ["FE-FC-FE-21-F5-D1", "FE-FC-FE-21-F5-D2"],
    "deviceType": "PC",
    "assetType": "BYOD"
}

返回数据

名称 类型 是否必须 默认值 备注 其他信息
code number 必须 错误码,非0表示失败
data object 必须 响应数据
├─ externalId string 必须 外部ID
msg string 必须 描述信息
traceId string 必须 调用链ID,链路请求的标识  

返回示例

{
    "code": 0,
    "data": {
        "externalId": "0c4e9039-f81d-11ec-a760-fefcfe545bb8"
    },
    "msg": "请求成功",
    "traceId": "0022c672e4c8b0d6"
}

错误信息

错误提示 错误码
MAC地址格式错误 7201
外部ID中不能含有非法的特殊字符:换行符,制表符,回车符 7201
外部ID长度超过最大上限:%d 7201
新外部ID中不能含有非法的特殊字符:换行符,制表符,回车符 7201
新外部ID长度超过最大上限:%d 7201
不支持的资产类型 7201
终端名称长度超过最大上限:%d 7201
终端名称中不能含有非法的特殊字符:换行符,制表符,回车符 7201
MAC地址不允许为空 7201
请输入匹配参数 10000001
请勿输入多个匹配参数: %s 10000001
终端不存在 77200001
匹配到多条终端,请求失败 37400404
不支持的设备类型 37400407
外部ID不允许为空 37400408
终端已存在 37400402
MAC地址数超过最大上限: %d 37400401
终端名称不能为空 37400403
深信服科技 all right reserved,powered by Gitbook本文档更新于: 2024-05-18 14:38

results matching ""

    No results matching ""